
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>list-nodes</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>list-nodes</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="list-network-listeners.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="list-nodes-config.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="list-nodes-1"></a><a id="GSRFM00187"></a><a id="list-nodes"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_list_nodes">list-nodes</h2>
<div class="sectionbody">
<div class="paragraph">
<p>lists all \{product---name} nodes in a domain</p>
</div>
<div id="sthref1700" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] list-nodes [--help]
[--long={false|true}]</code></pre>
</div>
</div>
<div id="sthref1701" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>list-nodes</code> subcommand lists all \{product---name} nodes in a
domain.</p>
</div>
<div class="paragraph">
<p>By default, the subcommand displays the following information for each
node that is listed:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The name of the node</p>
</li>
<li>
<p>The type of the node, which is one of the following types:::</p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>CONFIG</code></dt>
<dd>
<p>The node does not support remote communication.</p>
</dd>
<dt class="hdlist1"><code>DCOM</code></dt>
<dd>
<p>The node supports communication over the Distributed Component Object
Model (DCOM) remote protocol.</p>
</dd>
<dt class="hdlist1"><code>SSH</code></dt>
<dd>
<p>The node supports communication over secure shell (SSH).</p>
</dd>
</dl>
</div>
</li>
<li>
<p>The name of the host that the node represents</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The <code>--long</code> option of the subcommand specifies whether the nodes are
listed in long format. In long format, the following additional
information about each node is displayed:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The path to the parent of the base installation directory of
\{product---name} on the host that the node represents</p>
</li>
<li>
<p>A comma-separated list of the names of the \{product---name} instances
that reside on the node</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>If the <code>--terse</code> option of the
<a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> utility is <code>true</code> and the
<code>--long</code> option of the subcommand is <code>false</code>, the subcommand lists only
the name of each node.</p>
</div>
<div class="paragraph">
<p>This subcommand is supported in remote mode only.</p>
</div>
<div id="sthref1702" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--long</code></dt>
<dt class="hdlist1"><code>-l</code></dt>
<dd>
<p>Specifies whether the nodes are listed in long format.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>The nodes are listed in long format.</p>
</dd>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>The nodes are listed in short format (default).</p>
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<div id="sthref1703" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM687"></a><a id="sthref1704"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Listing \{product---name} Nodes</p>
</div>
<div class="paragraph">
<p>This example displays the name, type, and host for all \{product---name}
nodes in the domain <code>domain1</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; list-nodes
localhost-domain1  CONFIG  localhost
sj02  SSH  sj02.example.com
sj01  SSH  sj01.example.com
devnode  CONFIG  localhost
Command list-nodes executed successfully.</code></pre>
</div>
</div>
<div class="paragraph">
<p><a id="GSRFM688"></a><a id="sthref1705"></a></p>
</div>
<div class="paragraph">
<p>Example 2   Listing Only the Names of \{product---name} Nodes</p>
</div>
<div class="paragraph">
<p>This example uses the <code>--terse</code> option of the <code>asadmin</code> utility to list
only the names of the \{product---name} nodes in the domain <code>domain1</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; list-nodes --terse=true
localhost-domain1
sj02
sj01
devnode</code></pre>
</div>
</div>
<div class="paragraph">
<p><a id="GSRFM689"></a><a id="sthref1706"></a></p>
</div>
<div class="paragraph">
<p>Example 3   Listing \{product---name} Nodes in Long Format</p>
</div>
<div class="paragraph">
<p>This example lists the \{product---name} nodes in the domain <code>domain1</code>
in long format.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; list-nodes --long=true
NODE NAME           TYPE     NODE HOST          INSTALL DIRECTORY     REFERENCED BY
localhost-domain1   CONFIG   localhost          /export/glassfish3
sj02                SSH      sj02.example.com   /export/glassfish3    pmd-i2, yml-i2
sj01                SSH      sj01.example.com   /export/glassfish3    pmd-i1, yml-i1
devnode             CONFIG   localhost          /export/glassfish3    pmdsa1
Command list-nodes executed successfully.</code></pre>
</div>
</div>
<div id="sthref1707" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>command executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the command</p>
</dd>
</dl>
</div>
<div id="sthref1708" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="create-node-config.html#create-node-config-1"><code>create-node-config</code>(1)</a>,
<a href="create-node-dcom.html#create-node-dcom-1"><code>create-node-dcom</code>(1)</a>,
<a href="create-node-ssh.html#create-node-ssh-1"><code>create-node-ssh</code>(1)</a>,
<a href="delete-node-config.html#delete-node-config-1"><code>delete-node-config</code>(1)</a>,
<a href="delete-node-dcom.html#delete-node-dcom-1"><code>delete-node-dcom</code>(1)</a>,
<a href="delete-node-ssh.html#delete-node-ssh-1"><code>delete-node-ssh</code>(1)</a>,
<a href="list-nodes-config.html#list-nodes-config-1"><code>list-nodes-config</code>(1)</a>,
<a href="list-nodes-dcom.html#list-nodes-dcom-1"><code>list-nodes-dcom</code>(1)</a>,
<a href="list-nodes-ssh.html#list-nodes-ssh-1"><code>list-nodes-ssh</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="list-network-listeners.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="list-nodes-config.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
